GedcomX.getPlaces - Code Metrics - Inspection of "reduce duplicate code; close #16" - rootsdev/gedcomx-js - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 40c2b4...09bd06 )

by Justin

created 2016-09-21 21:53 UTC

GedcomX.getPlaces A

↳ Parent: src/GedcomX.js

Complexity

Conditions	1
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
c	0
b	0
f	0
nc	2
nop	0
dl	0
loc	3
rs	10

var ExtensibleData = require('./ExtensibleData'),
    Person = require('./Person'),
    Relationship = require('./Relationship'),
    SourceDescription = require('./SourceDescription'),
    Agent = require('./Agent'),
    Event = require('./Event'),
    Document = require('./Document'),
    PlaceDescription = require('./PlaceDescription'),
    Attribution = require('./Attribution'),
    utils = require('./utils');

/**
 * A GEDCOM X document.
 * 
 * @constructor
 * @param {Object} [json]

 */
var GedcomX = function(json){
  
  // Protect against forgetting the new keyword when calling the constructor
  if(!(this instanceof GedcomX)){
    return new GedcomX(json);
  }
  
  // If the given object is already an instance then just return it. DON'T copy it.
  if(GedcomX.isInstance(json)){
    return json;
  }
  
  ExtensibleData.call(this, json);
  
  if(json){
function isBig(a) {
    if (a > 5000) {
        return "yes";
    }
}

console.log(isBig(5001)); //returns yes
console.log(isBig(42)); //returns undefined
    this.setPersons(json.persons);
    this.setRelationships(json.relationships);
    this.setSourceDescriptions(json.sourceDescriptions);
    this.setAgents(json.agents);
    this.setEvents(json.events);
    this.setDocuments(json.documents);
    this.setPlaces(json.places);
    this.setAttribution(json.attribution);

  }
};

GedcomX.prototype = Object.create(ExtensibleData.prototype);

GedcomX._gedxClass = GedcomX.prototype._gedxClass = 'GedcomX';

/**
 * Check whether the given object is an instance of this class.
 * 
 * @param {Object} obj
 * @returns {Boolean}
 */
GedcomX.isInstance = function(obj){
  return utils.isInstance(obj, this._gedxClass);
};

/**
 * Get the persons
 * 
 * @returns {Person[]}
 */
GedcomX.prototype.getPersons = function(){
  return this.persons || [];
};

/**
 * Set the persons
 * 
 * @param {Person[]|Object[]} persons
 * @returns {GedcomX} This instance
 */
GedcomX.prototype.setPersons = function(persons){
  return this._setArray(persons, 'persons', 'addPerson');
};

/**
 * Add a person
 * 
 * @param {Person|Object}

 * @returns {GedcomX} This instance
 */
GedcomX.prototype.addPerson = function(person){
  return this._arrayPush(person, 'persons', Person);
};

/**
 * Get the relationships
 * 
 * @returns {Relationship[]}
 */
GedcomX.prototype.getRelationships = function(){
  return this.relationships || [];
};

/**
 * Set the relationships
 * 
 * @param {Relationship[]|Object[]} relationships
 * @returns {GedcomX}
 */
GedcomX.prototype.setRelationships = function(relationships){
  return this._setArray(relationships, 'relationships', 'addRelationship');
};

/**
 * Add a relationship
 * 
 * @param {Relationship|Object} relationship
 * @returns {GedcomX}
 */
GedcomX.prototype.addRelationship = function(relationship){
  return this._arrayPush(relationship, 'relationships', Relationship);
};

/**
 * Get the source descriptions
 * 
 * @returns {SourceDescription[]}
 */
GedcomX.prototype.getSourceDescriptions = function(){
  return this.sourceDescriptions || [];
};

/**
 * Set the source descriptions
 * 
 * @param {SourceDescription[]|Object[]} sourceDescriptions
 * @returns {GedcomX}
 */
GedcomX.prototype.setSourceDescriptions = function(sourceDescriptions){
  return this._setArray(sourceDescriptions, 'sourceDescriptions', 'addSourceDescription');
};

/**
 * Add a ource description
 * 
 * @param {SourceDescription|Object} sourceDescription
 * @returns {GedcomX}
 */
GedcomX.prototype.addSourceDescription = function(sourceDescription){
  return this._arrayPush(sourceDescription, 'sourceDescriptions', SourceDescription);
};

/**
 * Get the agents
 * 
 * @returns {Agent[]}
 */
GedcomX.prototype.getAgents = function(){
  return this.agents || [];
};

/**
 * Set the agents
 * 
 * @param {Agent[]|Object[]} agents
 * @returns {GedcomX}
 */
GedcomX.prototype.setAgents = function(agents){
  return this._setArray(agents, 'agents', 'addAgent');
};

/**
 * Add an agent
 * 
 * @param {Agent|Object}

 * @returns {GedcomX}
 */
GedcomX.prototype.addAgent = function(agent){
  return this._arrayPush(agent, 'agents', Agent);
};

/**
 * Get events
 * 
 * @returns {Event[]}
 */
GedcomX.prototype.getEvents = function(){
  return this.events || [];
};

/**
 * Set events
 * 
 * @param {Event[]|Object[]} events
 * @returns {GedcomX}
 */
GedcomX.prototype.setEvents = function(events){
  return this._setArray(events, 'events', 'addEvent');
};

/**
 * Add an event
 * 
 * @param {Event|Object} event
 * @returns {GedcomX}
 */
GedcomX.prototype.addEvent = function(event){
  return this._arrayPush(event, 'events', Event);
};

/**
 * Get the documents
 * 
 * @returns {Document[]}
 */
GedcomX.prototype.getDocuments = function(){
  return this.documents || [];
};

/**
 * Set the documents
 * 
 * @param {Documents[]|Object[]} documents
 * @returns {GedcomX}
 */
GedcomX.prototype.setDocuments = function(documents){
  return this._setArray(documents, 'documents', 'addDocument');
};

/**
 * Add a document
 * 
 * @param {Document|Object} doc
 * @returns {GedcomX}
 */
GedcomX.prototype.addDocument = function(doc){
  return this._arrayPush(doc, 'documents', Document);
};

/**
 * Get places
 * 
 * @returns {PlaceDescription[]}
 */
GedcomX.prototype.getPlaces = function(){
  return this.places || [];
};

/**
 * Set the places
 * 
 * @param {PlaceDescription[]|Object} places
 * @returns {GedcomX}
 */
GedcomX.prototype.setPlaces = function(places){
  return this._setArray(places, 'places', 'addPlace');
};

/**
 * Add a place
 * 
 * @param {PlaceDescription} place
 * @returns {GedcomX}
 */
GedcomX.prototype.addPlace = function(place){
  return this._arrayPush(place, 'places', PlaceDescription);
};

/**
 * Get attritbution
 * 
 * @returns {Attribution}
 */
GedcomX.prototype.getAttribution = function(){
  return this.attribution;
};

/**
 * Set attribution
 * 
 * @param {Attribution} attribution
 * @returns {GedcomX}
 */
GedcomX.prototype.setAttribution = function(attribution){
  if(attribution){
    this.attribution = Attribution(attribution);
  }
  return this;
};

/**
 * Export the object as JSON
 * 
 * @return {Object} JSON object
 */
GedcomX.prototype.toJSON = function(){
  return this._toJSON(ExtensibleData, [
    'persons',
    'relationships',
    'sourceDescriptions',
    'agents',
    'events',
    'documents',
    'places',
    'attribution'
  ]);
};

// Expose all classes
GedcomX.Address = require('./Address');
GedcomX.Agent = Agent;
GedcomX.Attribution = Attribution;
GedcomX.Conclusion = require('./Conclusion');
GedcomX.Coverage = require('./Coverage');
GedcomX.Date = require('./Date');
GedcomX.Document = Document;
GedcomX.Event = Event;
GedcomX.EventRole = require('./EventRole');
GedcomX.EvidenceReference = require('./EvidenceReference');
GedcomX.ExtensibleData = ExtensibleData;
GedcomX.Fact = require('./Fact');
GedcomX.Gender = require('./Gender');
GedcomX.Identifiers = require('./Identifiers');
GedcomX.Name = require('./Name');
GedcomX.NameForm = require('./NameForm');
GedcomX.NamePart = require('./NamePart');
GedcomX.Note = require('./Note');
GedcomX.OnlineAccount = require('./OnlineAccount');
GedcomX.Person = Person;
GedcomX.PlaceDescription = PlaceDescription;
GedcomX.PlaceReference = require('./PlaceReference');
GedcomX.Qualifier = require('./Qualifier');
GedcomX.Relationship = Relationship;
GedcomX.ResourceReference = require('./ResourceReference');
GedcomX.SourceCitation = require('./SourceCitation');
GedcomX.SourceDescription = SourceDescription;
GedcomX.SourceReference = require('./SourceReference');
GedcomX.Subject = require('./Subject');
GedcomX.TextValue = require('./TextValue');

module.exports = GedcomX;

1			var ExtensibleData = require('./ExtensibleData'),
2			Person = require('./Person'),
3			Relationship = require('./Relationship'),
4			SourceDescription = require('./SourceDescription'),
5			Agent = require('./Agent'),
6			Event = require('./Event'),
7			Document = require('./Document'),
8			PlaceDescription = require('./PlaceDescription'),
9			Attribution = require('./Attribution'),
10			utils = require('./utils');
11
12			/**
13			* A GEDCOM X document.
14			*
15			* @constructor
16			* @param {Object} [json]
			0 ignored issues – show Documentation introduced 2016-05-27 14:53 UTC by Report Bug Copy Issue Report The parameter `[json]` does not exist. Did you maybe forget to remove this comment? Loading history...
17			*/
18			var GedcomX = function(json){
19
20			// Protect against forgetting the new keyword when calling the constructor
21			if(!(this instanceof GedcomX)){
22			return new GedcomX(json);
23			}
24
25			// If the given object is already an instance then just return it. DON'T copy it.
26			if(GedcomX.isInstance(json)){
27			return json;
28			}
29
30			ExtensibleData.call(this, json);
31
32			if(json){
			0 ignored issues – show Complexity Best Practice introduced 2016-05-27 14:53 UTC by Report Bug Copy Issue Report There is no return statement if `json` is `false`. Are you sure this is correct? If so, consider adding `return;` explicitly. This check looks for functions where a `return` statement is found in some execution paths, but not in all. Consider this little piece of code function isBig(a) { if (a > 5000) { return "yes"; } } console.log(isBig(5001)); //returns yes console.log(isBig(42)); //returns undefined The function `isBig` will only return a specific value when its parameter is bigger than 5000. In any other case, it will implicitly return `undefined`. This behaviour may not be what you had intended. In any case, you can add a `return undefined` to the other execution path to make the return value explicit. Loading history...
33			this.setPersons(json.persons);
34			this.setRelationships(json.relationships);
35			this.setSourceDescriptions(json.sourceDescriptions);
36			this.setAgents(json.agents);
37			this.setEvents(json.events);
38			this.setDocuments(json.documents);
39			this.setPlaces(json.places);
40			this.setAttribution(json.attribution);
			0 ignored issues – show Best Practice introduced 2016-05-27 14:53 UTC by Report Bug Copy Issue Report There is no `return` statement in this branch, but you do return something in other branches. Did you maybe miss it? If you do not want to return anything, consider adding `return undefined;` explicitly. Loading history...
41			}
42			};
43
44			GedcomX.prototype = Object.create(ExtensibleData.prototype);
45
46			GedcomX._gedxClass = GedcomX.prototype._gedxClass = 'GedcomX';
47
48			/**
49			* Check whether the given object is an instance of this class.
50			*
51			* @param {Object} obj
52			* @returns {Boolean}
53			*/
54			GedcomX.isInstance = function(obj){
55			return utils.isInstance(obj, this._gedxClass);
56			};
57
58			/**
59			* Get the persons
60			*
61			* @returns {Person[]}
62			*/
63			GedcomX.prototype.getPersons = function(){
64			return this.persons \|\| [];
65			};
66
67			/**
68			* Set the persons
69			*
70			* @param {Person[]\|Object[]} persons
71			* @returns {GedcomX} This instance
72			*/
73			GedcomX.prototype.setPersons = function(persons){
74			return this._setArray(persons, 'persons', 'addPerson');
75			};
76
77			/**
78			* Add a person
79			*
80			* @param {Person\|Object}
			0 ignored issues – show Documentation introduced 2016-05-27 14:53 UTC by Report Bug Copy Issue Report The parameter `*` does not exist. Did you maybe forget to remove this comment? Loading history...
81			* @returns {GedcomX} This instance
82			*/
83			GedcomX.prototype.addPerson = function(person){
84			return this._arrayPush(person, 'persons', Person);
85			};
86
87			/**
88			* Get the relationships
89			*
90			* @returns {Relationship[]}
91			*/
92			GedcomX.prototype.getRelationships = function(){
93			return this.relationships \|\| [];
94			};
95
96			/**
97			* Set the relationships
98			*
99			* @param {Relationship[]\|Object[]} relationships
100			* @returns {GedcomX}
101			*/
102			GedcomX.prototype.setRelationships = function(relationships){
103			return this._setArray(relationships, 'relationships', 'addRelationship');
104			};
105
106			/**
107			* Add a relationship
108			*
109			* @param {Relationship\|Object} relationship
110			* @returns {GedcomX}
111			*/
112			GedcomX.prototype.addRelationship = function(relationship){
113			return this._arrayPush(relationship, 'relationships', Relationship);
114			};
115
116			/**
117			* Get the source descriptions
118			*
119			* @returns {SourceDescription[]}
120			*/
121			GedcomX.prototype.getSourceDescriptions = function(){
122			return this.sourceDescriptions \|\| [];
123			};
124
125			/**
126			* Set the source descriptions
127			*
128			* @param {SourceDescription[]\|Object[]} sourceDescriptions
129			* @returns {GedcomX}
130			*/
131			GedcomX.prototype.setSourceDescriptions = function(sourceDescriptions){
132			return this._setArray(sourceDescriptions, 'sourceDescriptions', 'addSourceDescription');
133			};
134
135			/**
136			* Add a ource description
137			*
138			* @param {SourceDescription\|Object} sourceDescription
139			* @returns {GedcomX}
140			*/
141			GedcomX.prototype.addSourceDescription = function(sourceDescription){
142			return this._arrayPush(sourceDescription, 'sourceDescriptions', SourceDescription);
143			};
144
145			/**
146			* Get the agents
147			*
148			* @returns {Agent[]}
149			*/
150			GedcomX.prototype.getAgents = function(){
151			return this.agents \|\| [];
152			};
153
154			/**
155			* Set the agents
156			*
157			* @param {Agent[]\|Object[]} agents
158			* @returns {GedcomX}
159			*/
160			GedcomX.prototype.setAgents = function(agents){
161			return this._setArray(agents, 'agents', 'addAgent');
162			};
163
164			/**
165			* Add an agent
166			*
167			* @param {Agent\|Object}
			0 ignored issues – show Documentation introduced 2016-05-27 14:53 UTC by Report Bug Copy Issue Report The parameter `*` does not exist. Did you maybe forget to remove this comment? Loading history...
168			* @returns {GedcomX}
169			*/
170			GedcomX.prototype.addAgent = function(agent){
171			return this._arrayPush(agent, 'agents', Agent);
172			};
173
174			/**
175			* Get events
176			*
177			* @returns {Event[]}
178			*/
179			GedcomX.prototype.getEvents = function(){
180			return this.events \|\| [];
181			};
182
183			/**
184			* Set events
185			*
186			* @param {Event[]\|Object[]} events
187			* @returns {GedcomX}
188			*/
189			GedcomX.prototype.setEvents = function(events){
190			return this._setArray(events, 'events', 'addEvent');
191			};
192
193			/**
194			* Add an event
195			*
196			* @param {Event\|Object} event
197			* @returns {GedcomX}
198			*/
199			GedcomX.prototype.addEvent = function(event){
200			return this._arrayPush(event, 'events', Event);
201			};
202
203			/**
204			* Get the documents
205			*
206			* @returns {Document[]}
207			*/
208			GedcomX.prototype.getDocuments = function(){
209			return this.documents \|\| [];
210			};
211
212			/**
213			* Set the documents
214			*
215			* @param {Documents[]\|Object[]} documents
216			* @returns {GedcomX}
217			*/
218			GedcomX.prototype.setDocuments = function(documents){
219			return this._setArray(documents, 'documents', 'addDocument');
220			};
221
222			/**
223			* Add a document
224			*
225			* @param {Document\|Object} doc
226			* @returns {GedcomX}
227			*/
228			GedcomX.prototype.addDocument = function(doc){
229			return this._arrayPush(doc, 'documents', Document);
230			};
231
232			/**
233			* Get places
234			*
235			* @returns {PlaceDescription[]}
236			*/
237			GedcomX.prototype.getPlaces = function(){
238			return this.places \|\| [];
239			};
240
241			/**
242			* Set the places
243			*
244			* @param {PlaceDescription[]\|Object} places
245			* @returns {GedcomX}
246			*/
247			GedcomX.prototype.setPlaces = function(places){
248			return this._setArray(places, 'places', 'addPlace');
249			};
250
251			/**
252			* Add a place
253			*
254			* @param {PlaceDescription} place
255			* @returns {GedcomX}
256			*/
257			GedcomX.prototype.addPlace = function(place){
258			return this._arrayPush(place, 'places', PlaceDescription);
259			};
260
261			/**
262			* Get attritbution
263			*
264			* @returns {Attribution}
265			*/
266			GedcomX.prototype.getAttribution = function(){
267			return this.attribution;
268			};
269
270			/**
271			* Set attribution
272			*
273			* @param {Attribution} attribution
274			* @returns {GedcomX}
275			*/
276			GedcomX.prototype.setAttribution = function(attribution){
277			if(attribution){
278			this.attribution = Attribution(attribution);
279			}
280			return this;
281			};
282
283			/**
284			* Export the object as JSON
285			*
286			* @return {Object} JSON object
287			*/
288			GedcomX.prototype.toJSON = function(){
289			return this._toJSON(ExtensibleData, [
290			'persons',
291			'relationships',
292			'sourceDescriptions',
293			'agents',
294			'events',
295			'documents',
296			'places',
297			'attribution'
298			]);
299			};
300
301			// Expose all classes
302			GedcomX.Address = require('./Address');
303			GedcomX.Agent = Agent;
304			GedcomX.Attribution = Attribution;
305			GedcomX.Conclusion = require('./Conclusion');
306			GedcomX.Coverage = require('./Coverage');
307			GedcomX.Date = require('./Date');
308			GedcomX.Document = Document;
309			GedcomX.Event = Event;
310			GedcomX.EventRole = require('./EventRole');
311			GedcomX.EvidenceReference = require('./EvidenceReference');
312			GedcomX.ExtensibleData = ExtensibleData;
313			GedcomX.Fact = require('./Fact');
314			GedcomX.Gender = require('./Gender');
315			GedcomX.Identifiers = require('./Identifiers');
316			GedcomX.Name = require('./Name');
317			GedcomX.NameForm = require('./NameForm');
318			GedcomX.NamePart = require('./NamePart');
319			GedcomX.Note = require('./Note');
320			GedcomX.OnlineAccount = require('./OnlineAccount');
321			GedcomX.Person = Person;
322			GedcomX.PlaceDescription = PlaceDescription;
323			GedcomX.PlaceReference = require('./PlaceReference');
324			GedcomX.Qualifier = require('./Qualifier');
325			GedcomX.Relationship = Relationship;
326			GedcomX.ResourceReference = require('./ResourceReference');
327			GedcomX.SourceCitation = require('./SourceCitation');
328			GedcomX.SourceDescription = SourceDescription;
329			GedcomX.SourceReference = require('./SourceReference');
330			GedcomX.Subject = require('./Subject');
331			GedcomX.TextValue = require('./TextValue');
332
333			module.exports = GedcomX;

rootsdev / gedcomx-js

Push — master ( 40c2b4...09bd06 )

GedcomX.getPlaces A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like